Item(Field,Nullable<Boolean>) Property

Indexer

Syntax

Visual Basic

'Declaration
 
Public Overloads ReadOnly Property Item( _
   ByVal field As Field, _
   ByVal isGroupBy As Nullable(Of Boolean) _
) As FieldSortDescription

C#

public FieldSortDescription Item( 
   Field field,
   Nullable<bool> isGroupBy
) {get;}

Parameters

field

The associated FieldSortDescription for this field and IsGroupBy state

isGroupBy

If non-null will only return the FieldSortDescription with the matching field and IsGroupBy value.

Property Value

The FieldSortDescription in the collection that is associated with this field and IsGroupBy state.

Remarks

Note: the collection can now contain up to 2 instances of FieldSortDescriptions with the same field (one with its IsGroupBy set to true and the other with its IsGroupBy set to false). This method will return the first instance that matches the field if the isGroupBy parameter is null. In the case where there are 2 instances it will always return the one with its IsGroupBy set to true. This is because the collection is sorted such that all 'groupby' FieldSortDescriptions come before all 'non-groupby' ones.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2